/**
 *
 *  Copyright (c) 2011, AstroDAbis
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without modification,
 *  are permitted provided that the following conditions are met:
 *
 *      * Redistributions of source code must retain the above copyright notice,
 *        this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright notice,
 *        this list of conditions and the following disclaimer in the documentation
 *        and/or other materials provided with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 *  OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jiscinvolve.astrodabis.mallow.control.tags;

import javax.validation.Valid;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.stereotype.Controller;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.context.request.WebRequest;

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ModelAttribute;

import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional; 

import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.validation.BindingResult;

import org.jiscinvolve.astrodabis.mallow.model.api.Tag;
import org.jiscinvolve.astrodabis.mallow.model.api.TagBean;
import org.jiscinvolve.astrodabis.mallow.model.api.Account;
import org.jiscinvolve.astrodabis.mallow.model.jpa.DuplicateEntryException;

import org.jiscinvolve.astrodabis.mallow.control.ViewData;
import org.jiscinvolve.astrodabis.mallow.control.BaseController;
import org.jiscinvolve.astrodabis.mallow.control.NotFoundException;
import org.jiscinvolve.astrodabis.mallow.control.PermissionException;

/**
 * User page controller
 *
 */
@Controller
@RequestMapping("/tags/create")
public class TagCreateController
extends BaseController
    {

    /**
     * Our debug logger.
     * 
     */
    private static Log log = LogFactory.getLog(TagCreateController.class);

    /**
     * Tag create form path.
     * 
     */
    public static final String FORM_VIEW = "tags/tag-create" ;

    /**
     * Form attribute name.
     * 
     */
    public static final String FORM_DATA = "form" ;

    /**
     * Create the ViewData for this request.
     *
     */
    @ModelAttribute(ViewData.VIEW_DATA)
    public ViewData data(
        WebRequest request
        ){
        return new ViewData(
            request,
            this.actor(
                request
                )
            );
        }

    /**
     * Get the create tag form.
     * 
     */
	@RequestMapping(method=RequestMethod.GET)
	public ModelAndView page(
	    @ModelAttribute(ViewData.VIEW_DATA) ViewData data,
	    ModelAndView model
	    ){
        Account actor = data.actor();        
        log.debug("TagCreateController.page(....)");
        log.debug(" Actor [" + ((actor != null) ? actor.ident() : null ) + "]");
        //
        // If we are not logged in.
        if (actor == null)
            {
            throw new PermissionException();
            }
        //
        // If we are logged in.
        else {
            model.addObject(
                FORM_DATA,
                new TagBeanImpl()
                );
            model.setViewName(
    		    FORM_VIEW
                );
            }
        return model ;
        }

    /**
     * Post the create tag form.
     * 
     */
	@RequestMapping(method=RequestMethod.POST)
	public ModelAndView post(
	    @ModelAttribute(FORM_DATA) @Valid TagBeanImpl bean, BindingResult result,
	    @ModelAttribute(ViewData.VIEW_DATA) ViewData data,
	    ModelAndView model
	    ){
        Account actor = data.actor();        
        log.debug("TagCreateController.page(....)");
        log.debug(" Actor [" + ((actor != null) ? actor.ident() : null ) + "]");
        //
        // If we are not logged in.
        if (actor == null)
            {
            throw new PermissionException();
            }
        //
        // If we are logged in.
        else {
            //
            // If the input is not valid, re-display the form page.
		    if (result.hasErrors())
		        {
                log.debug("Input has errors");
                for(FieldError error : result.getFieldErrors())
                    {
                    log.debug("  Error [" + error.getObjectName() + "][" + error.getField() + "][" + error.getDefaultMessage() + "]");
                    }
        		model.setViewName(
                    FORM_VIEW
                    );
		        }
            //
            // If the input is valid.
            else {
                //
                // Try creating the new tag.
                try {
                    Tag tag = this.create(
                        actor,
                        bean
                        );
                    //
                    // Re-direct to the tag details page.
            		model.setViewName(
                        data.redirect(
                            tag
                            )
                        );
                    }
                //
                // If name is alredy registered.
                catch (DuplicateEntryException ouch)
                    {
                    if ("name".equals(ouch.field()))
                        {
                        result.addError(
                            new FieldError(
                                FORM_DATA,
                                "name",
                                "You already have a tag called [" + bean.getName() + "]"
                                )
                            );
                        }
                    else {
                        log.warn("Unknown field in DuplicateEntryException [" + ouch.field() + "]");
                        result.addError(
                            new ObjectError(
                                FORM_DATA,
                                "Sorry, that tag has already been created"
                                )
                            );
                        }
            		model.setViewName(
                        FORM_VIEW
                        );
                    }
                //
                // Anything goes wrong, add an error and re-display the form page.
                catch (Throwable ouch)
                    {
                    log.error("Exception while creating Tag [" + ouch.getClass().getName() + "][" + ouch.getMessage() + "]");
                    result.addError(
                        new ObjectError(
                            FORM_DATA,
                            "Failed to create the tag due to technical problems, please try again later"
                            )
                        );
            		model.setViewName(
                        FORM_VIEW
                        );
                    }
                }
            }
        return model ;
        }

    /**
     * Create the Tag.
     *
     */
    @Transactional(readOnly=false, propagation=Propagation.REQUIRES_NEW)
    protected Tag create(Account actor, TagBean bean)
    throws DuplicateEntryException
        {
        return actor.tags().create(
            bean
            );
        }
    }

